Hybris UX Api

Update Order Details for the PR market

This API is used to update the technician appointment for particular Order.

GET /searchTimeSlot API should be executed before updating the appointment to get the available technician's timeslot.

URL

https://[localhost]:[port]/ecom-ux/v1/{businessId}/appointment/{id}

url Param

Header

Sample Request for Installation appointment:

postman request PATCH 'https://nonprod.esb.cloud.lla.com/dev/ecom-ux/ecom-ux/v1/PR/appointment/1200876519981002' \
  --header 'client_id: abcde' \
  --header 'client_secret: 12345' \
  --header 'X-Correlation-ID: {guid}' \
  --header 'Content-Type: application/json' \
  --body '{
    "category": "Installation",
    "validFor": {
        "startDateTime": "2026-03-05T12:00:00.000-04:00" //reschedule date
    },
    "lastUpdate": "2026-03-04T12:00:00.000-04:00", //last schedule date
    "relatedEntity": [
        {
            "@type": "RelatedEntity",
            "@referredType": "RescheduleReason",
            "id": "CR",
            "name": "User rescheduled appointment",
            "role": "rescheduleReason"
        },
        {
            "id": "8211990010043876",
            "role": "Customer Account",
            "@referredType": "BillingAccount",
            "characteristics": [
                {
                    "name": "type",
                    "value": "RES"
                },
                {
                    "name": "provisionableType",
                    "value": "P"
                }
            ]
        }
    ],
    "relatedParty": [
        {
            "role": "Technician",
            "id": "7000",
            "@referredType": "Individual"
        },
        {
            "role": "Sales Representative",
            "id": "00000",
            "@referredType": "Individual"
        }
    ],
    "characteristics": [
        {
            "name": "campaignCode",
            "value": "000"
        },
        {
            "name": "orderReasonCode",
            "value": "H1"
        },
        {
            "name": "jobType",
            "value": "E1"
        }
    ]
}'

Sample Request for Technical appointment:

postman request PATCH 'https://nonprod.esb.cloud.lla.com/dev/ecom-ux/ecom-ux/v1/PR/appointment/6546789199810872' \
  --header 'client_id: abcde' \
  --header 'client_secret: 12345' \
  --header 'X-Correlation-ID: {guid}' \
  --header 'Content-Type: application/json' \
  --body '{
    "category": "Trouble Call",
    "validFor": {
        "startDateTime": "2026-03-05T12:00:00.000-04:00" //reschedule date
    },
    "lastUpdate": "2026-03-02T12:00:00.000-04:00",
    "relatedEntity": [
        {
            "@type": "RelatedEntity",
            "@referredType": "RescheduleReason",
            "id": "CR",
            "name": "User rescheduled appointment",
            "role": "rescheduleReason"
        },
        {
            "id": "8211990010043396",
            "role": "Customer Account",
            "@referredType": "BillingAccount"
        }
    ],
    "relatedParty": [
        {
            "role": "Technician",
            "id": "7000",
            "@referredType": "Individual"
        }
    ],
    "characteristics": [
        {
            "name": "jobType",
            "value": "TF"
        },
        {
            "name": "jobStatus",
            "value": "R"
        }
    ]
}'

Definitions

Each of the request parameters is detailed.

Response

{
    "status": "confirmed",
    "category": "Installation",
    "validFor": {
        "startDateTime": "2026-03-05T12:00:00.000-04:00"
    },
    "lastUpdate": "2026-03-04T12:00:00.000-04:00",
    "relatedEntity": [
        {
            "@type": "RelatedEntity",
            "@referredType": "RescheduleReason",
            "id": "CR",
            "name": "User rescheduled appointment",
            "role": "cancellationReason"
        },
        {
            "id": "8211990010043396",
            "role": "Customer Account",
            "@referredType": "BillingAccount",
            "characteristics": [
                {
                    "name": "type",
                    "value": "RES"
                },
                {
                    "name": "provisionableType",
                    "value": "P"
                }
            ]
        }
    ],
    "relatedParty": [
        {
            "role": "Technician",
            "id": "7000",
            "@referredType": "Individual"
        },
        {
            "role": "Sales Representative",
            "id": "00000",
            "@referredType": "Individual"
        }
    ],
    "characteristics": [
        {
            "name": "campaignCode",
            "value": "000"
        },
        {
            "name": "orderReasonCode",
            "value": "H1"
        }
        {
            "name": "jobType",
            "value": "E1"
        }
    ]
}

Definitions

Each of the response parameters is detailed.

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "BAD REQUEST",
      "description" : "Start date is mandatory field to update Appointment"
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 403 ]

Forbidden - Indicates that the server understood the request but refuses to fulfill it. If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials.

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "Appointment not found",
      "description" : "No appointment Available for this Order"
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method POST not allowed for : /{businessId}/appointment/{id}"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "Internal Server Error",
      "description": "The request failed due to an internal error."
    }]
}